home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / UTILITY / FILES15.ARJ / FILES.DOC next >
Text File  |  1991-02-25  |  9KB  |  201 lines
  1.  
  2. files - List Files                                       25-Feb-91
  3.  
  4. Syntax:
  5.  
  6.     files [path] [options]
  7.  
  8. Options:
  9.  
  10.     +directory   - display directories instead of files.
  11.     +all         - display both directory files and regular files
  12.     s=key        - specify how the directory entries are to be sorted. key may
  13.                    be no[ne], na[me], d[date], or s[ize]. 
  14.     +current     - only display files at the current level. By default, files
  15.                    will traverse any subdirectories that it finds. 
  16.     +modified    - only display files which have the "modified" (or "archive")
  17.                    bit set.
  18.     -sort        - don't sort the file names. This is equivalent to s=none.
  19.     -verbose     - display only the name of the file, one file per line
  20.     +verbose     - adds file attriubutes to the default display, one file per
  21.                    line. 
  22.     +totals_only - suppresses the information about individual files. Only the
  23.                    totals are displayed. 
  24.     +Before      - changes the date/time matching from files >= to the user's
  25.                    date/time to files <= the user's date/time.
  26.     p=pattern    - display only those files whose names match this pattern.
  27.                    This option is included for compatibility with the QNX
  28.                    version of this utility, and to allow the user specify
  29.                    more than one file name to search for. Note that only a
  30.                    filename may be specified, not a complete path. 
  31.     d=[dd-mmm-yy]- display only those files whose date is >= to this date. Note
  32.                    that d= implies the current date. The absense of a t= 
  33.                    specification implies a time of 00:00:00.
  34.     d=([-]#days) - specifies a number of days relative to today. This may be
  35.                    positive or negative. 
  36.     t=hh:mm[:ss] - Modifies the time associated with the d= specification. Note
  37.                    that in the absense of a d= specification, the current date
  38.                    is assumed.
  39.     +1           - forces a single column display of file names, rather than the
  40.                    two filenames per line which is the default when only a 
  41.                    single directory is being displayed. 
  42.     +Date_sort   - sorts the files by date, rather than by name.
  43.     +Mkdir       - display mkdir commands to re-create the specified directory
  44.                    tree.
  45.     +Subtotals   - diplays the number of files, and the total number of bytes
  46.                    on a directory by directory basis. 
  47.     +pause       - pauses at the end of each page displayed, requiring that the
  48.                    user press return to continue.
  49.     -pause       - overrides the default of pausing during the help display
  50.     +help        - generates the help display. -help and ? will also generate
  51.                    the help display. 
  52.  
  53.         
  54. Description:
  55.  
  56. The FILES command allows the user to list the files at or below any point in 
  57. the file structure. If no path is specified, then the current disk/directory
  58. is assumed. The FILES command will walk the entire tree structure recursively,
  59. displaying all files at the specified (or current) directory, followed by
  60. all files at lower levels. The +current option prevents the recursive walk
  61. of the file "tree", causing only those files at the current level to be
  62. displayed. 
  63.  
  64. Normally, the names of the files within a directory will be sorted by file name
  65. before being displayed, and the directories will be sorted also. This feature 
  66. can be turned off by specifying the -sort option (or s=none), in which case 
  67. the file names and directories will be displayed in the order that they are 
  68. found. When sorting, files at the current directory will be displayed first, 
  69. followed by any files at lower levels. 
  70.  
  71. The s=key option allows the user to specify alternative sort keys. The files
  72. within a directory name be sorted by name (s=name), date (s=date), size
  73. (s=size), or not sorted (s=none). The +Date_sort option is equivalent to
  74. s=date. 
  75.  
  76. The FILES command will not normally print the names of directories. If the 
  77. user wishes to examine directories which exist at this and lower levels, the 
  78. +directory option will enable the display of directory names, and will suppress
  79. the display of normal file names. The -sort and +current options apply to
  80. directories as well as normal files. The d= and t= options also apply.
  81.  
  82. Normally the FILES utility will display either regular file names, or directory
  83. file names, but not both at once. The +all switch overrides this behavior.
  84. Directory files are preceded by a '+', and regular files are preceded by a 
  85. blank. 
  86.  
  87. The default display shows file size, file date, and file name. Two files are
  88. displayed per line. Whenever a filename is preceded by a directory name,
  89. only one filename is displayed per line. 
  90.  
  91.  
  92. Pattern Matching:
  93.  
  94. If desired, only files whose name matches a pattern will be displayed. The
  95. pattern is typically specified as part of the path, but it also may be specified
  96. using the p= option. A pattern may be any valid filename, and may include any 
  97. of the following wildcards:
  98.  
  99.     *       matches any run of characters
  100.     ?       matches any single character
  101.     [a-z]   matches any character, 'a'- 'z'
  102.     [az]    matches either an 'a' or a 'z'
  103.     *a*.doc matches any ".doc" file which contains an 'a' prior to the period
  104.             Note that this form of pattern matching is considerable different
  105.             that what is provided under MS-DOS. Under MS-DOS, a '*' 
  106.             automatically assumes the remainder of the field. Thus "*" and
  107.             "*a*" are equivalent when using MS-DOS's pattern matching. 
  108.  
  109. The pattern may be prefixed by a a '^' character, which indicates to match on
  110. any file which does NOT match the pattern. For example, specifying "^*.c"
  111. will match all files which do not end in ".c". Likewise, a '^' may be
  112. specified as the first character inside the [] pair. This specifies that
  113. any character which does not match those specified is acceptable. 
  114.  
  115. A filename which does not contain an extention may be specified as "filename",
  116. "filename.", or "filename.*". 
  117.  
  118. A '*' at of a pattern will match any run of characters. Thus "pattern*" is 
  119. equivalent to "pattern*.*".
  120.  
  121. Up to 10 patterns may be specified. 
  122.  
  123. The +verbose switch can be used to display extended information for each file in
  124. the directory. For MS-DOS, the following information will be presented: 
  125.  
  126.     a  ARCHIVE. The file has been modified.
  127.     s  SYSTEM. The file is a system file.
  128.     h  HIDDEN. The file is hidden.
  129.     r  READ-ONLY. The file cannot be modfied. 
  130.     v  VOLUME-ID. The file is a volume id. (this bit is not currently displayed).
  131.  
  132. Examples:
  133.  
  134.     files +c
  135.  
  136.     This will print the names, size, and time/date of the files in the current
  137.     directory only.
  138.  
  139.     files c:\msc p=*.h
  140.     files c:\msc\*.h
  141.  
  142.     These commands will print the names of any file that matches the pattern
  143.     "*.h" in the directory tree that begins at "c:\msc".
  144.  
  145.     files c: +v
  146.  
  147.     This command will generate a listing of all of the files on the C: disk.
  148.  
  149.     files c:*.exe p=*.com p=*.bat
  150.  
  151.     This command will locate all of the "executable" files on the C: disk.
  152.  
  153.     files c: d=21-Jun-88
  154.  
  155.     This command will locates all of the files on the C: disk which were 
  156.     created/modified on or after 21-Jun-88. 
  157.  
  158.     files c: d=21-Jun-88 +Before
  159.  
  160.     This command will locates all of the files on the C: disk which were 
  161.     created/modified before 21-Jun-88. 
  162.  
  163.     files d=
  164.  
  165.     This command will locates all of the files in the current directory which 
  166.     were created/modified today. 
  167.  
  168.     files d=(1)
  169.  
  170.     This command will locates all of the files in the current directory which 
  171.     were created/modified one day past today. This is useful for locating 
  172.     files which were created when the date was not set. 
  173.  
  174.     files d=(-5)
  175.  
  176.     This command will locates all of the files in the current directory which 
  177.     were created/modified in the last 6 days (today or the preceding 5 days).
  178.  
  179.     files c: +modified >modified.lst
  180.  
  181.     This command will locates all of the files on the C: disk which were
  182.     created/modified since the last backup, and redirects the list to the
  183.     file "modified.lst" in the current directory. 
  184.  
  185.  
  186.  
  187.                               NOTICE
  188.  
  189.        This program has been released to the public domain by its
  190.        author.  You may use it, modify it, and copy it for others to
  191.        use.  You may NOT sell it or otherwise charge for its
  192.        distribution, except that recognized user groups may charge a
  193.        small fee for copying, materials, postage, etc.
  194.  
  195.        If you have any suggestions, comments, or bugs to report, my address is:
  196.  
  197.        Bruce F. Damkoehler
  198.        3627 Briggs Boulevard NE
  199.        Grand Rapids, MI  49505
  200.  
  201.